chore(developer): consolidate api-extractor usage in Developer#16135
Open
mcdurdin wants to merge 1 commit into
Open
chore(developer): consolidate api-extractor usage in Developer#16135mcdurdin wants to merge 1 commit into
mcdurdin wants to merge 1 commit into
Conversation
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
github-actions
Bot
added
developer/
common/
developer/compilers/
resources/
chore
labels
mcdurdin
force-pushed
the
chore/developer/14838-consolidate-api-extractor
branch
from
1ea69c9 to
407ce71
Compare
mcdurdin
force-pushed
the
chore/developer/14838-consolidate-api-extractor
branch
from
407ce71 to
d866049
Compare
ermshiperete
requested changes
Jun 25, 2026
ermshiperete
left a comment
ermshiperete
left a comment
Contributor
There was a problem hiding this comment.
LGTM, except I think the paths are wrong in most of the modified build.sh files.
|
|
||
| # Notes | ||
|
|
||
| These files are used by `typescript_run_api_extractor()` in typescript.inc.sh. |
Contributor
There was a problem hiding this comment.
We might want to move this sentence to the top of the file. Also, a sentence what api-extractor does or why we do it might be helpful. I guess we're talking about https://api-extractor.com/ ?
We could also reference .github/workflows/api-verification.yml which maybe does a similar thing for the desktop platforms.
| @@ -0,0 +1,15 @@ | |||
| { | |||
| "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | |||
| "extends": "$keyman_root/common/tools/api-extractor/api-extractor.base.json", | |||
Contributor
There was a problem hiding this comment.
If we would put the variables we replace in uppercase they would be easier to spot.
| builder_run_action configure node_select_version_and_npm_ci | ||
| builder_run_action build do_build | ||
| builder_run_action api api-extractor run --local --verbose | ||
| builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts |
Contributor
There was a problem hiding this comment.
I'd guess this should be
Suggested change
| builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts | |
| builder_run_action api typescript_run_api_extractor developer/src/kmc-generate main.d.ts |
(similarly in the other build.sh files...)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #14838
Test-bot: skip